فایل README چیست؟

README همانطور که از نامش پیداست: “read me” اولین فایلی است که باید هنگام شروع یک پروژه جدید بخواند. این فایل مجموعه ای از اطلاعات مفید در مورد یک پروژه و نوعی کتابچه راهنمای کاربر است. یک فایل متنی README در مکان های مختلف ظاهر می شود و نه تنها به برنامه نویسی اشاره دارد. فایل README اضافه شده در گیت هاب در زیر لیست فایل های موجود در یک repo ظاهر می شود.

استفاده و بکارگیری رنگ مناسب در طراحی وبسایت و جذب مخاطب بسیار مهم و حیاتی است. توصیه می کنم جهت آشنایی با بهترین پالت های رنگی مقاله بهترین پالت های رنگی وب سایت در سال 2021 را از دست ندهید.

فایل-README-چیست؟ ?

اگر به صورت حرفه ای کار کنید یا کد نویسی را یاد بگیرید، بارها با مخازن عمومی مواجه می شویم. بهتر است از کتابخانه‌هایی که توسط توسعه‌دهندگان دیگر در دسترس است به عنوان کد منبع باز استفاده می‌کنید یا در پروژه، گزارش و رفع اشکالات و افزودن قابلیت‌های جدید مشارکت کنید. از این پروژه‌ها استفاده می‌کنید، زیرا آنها به کار می‌آیند و راه‌حلی با کیفیت بالا ارائه می‌دهند.

مطمئن باشید، هنگام یافتن راه حل بالقوه برای همه مشکلات خود در یک کتابخانه یا پروژه ای که شرح آن ضعیف، بی فایده یا به هیچ وجه در دسترس نیست، با احساس ناامیدی آشنا خواهید شد.

علت نیاز به یک فایل README خوب

یک فایل README راهنمایی است که به کاربران شرح مفصلی از پروژه ای که به مخزن خود منتقل کرده اید می دهد. شاید برای شما این سوال پیش آمده باشد که چرا باید برای نوشتن یک README خوب وقت بگذارید. خوب چند دلیل برای کمک به متقاعد کردن شما به اینکه ایده خوبی است وجود دارد:

یک README خوب به پروژه های شما کمک می کند تا از بسیاری از پروژه های دیگر متمایز شوند. باید به خوبی خود پروژه باشد.
این اولین فایلی است که شخص هنگام مواجهه با پروژه شما می بیند، بنابراین باید نسبتا مختصر اما مفصل باشد.
این به شما کمک می کند تا روی آنچه پروژه شما باید ارائه دهد و چگونه تمرکز کنید.

یک نویسنده خوب نه تنها روحیه خودش را دارد، بلکه روح دوستانش را نیز دارد. ” فردریش نیچه “

هنگام نوشتن یک README، همیشه به خاطر داشته باشید که برای درک کد شما به دوستان خود یا در این مورد دیگر توسعه دهندگان نیاز دارید. برای مثال برخی از پروژه ها README دقیق، توضیحات یا هیچ راهنمایی ندارد.

با چنین پروژه هایی در GitHub هیچ کس نمی تواند بفهمد که چه کاری انجام می دهد مهم نیست که چقدر زمان برای ایجاد آن صرف کرده اید.

اما با مشاهده برخی دیگر از پروژه های می‌توانید بفهمید که پروژه چه کاری انجام می‌دهد، چه چیزی مستلزم آن است و اگر نیاز به استفاده از پروژه دارید یا می‌خواهید در آن مشارکت داشته باشید، چگونه شروع کنید. این دقیقا قدرت نوشتن یک README خوب است.

نحوه نوشتن یک فایل README خوب

در ادامه مراحلی وجود دارد که باید برای نوشتن README خود طی کنید.

درج عنوان پروژه خود

این نام پروژه است. کل پروژه را در یک جمله توصیف می کند و به افراد کمک می کند تا بفهمند هدف اصلی پروژه چیست. در انتخاب عنوان پروژه خود به خوبی دقت نمایید. بطوری باید انتخاب شود که به راحتی هر چه تمام نشان دهنده کاری که در آن پروژه قرار است انجام شود، باشد.

نگارش یک توضیحات مختصر

توضیحات شما یک جنبه بسیار مهم از پروژه شما است. یک توصیف خوب به شما امکان می دهد کار خود را به سایر توسعه دهندگان و همچنین کارفرمایان بالقوه نشان دهید. این یکی از اجزای مهم پروژه شما است که بسیاری از توسعه دهندگان جدید اغلب آن را نادیده می گیرند.

کیفیت توضیحات README اغلب یک پروژه خوب را از یک پروژه بد متمایز می کند. یک توسعه دهنده خوب از این فرصت برای توضیح و نمایش استفاده می کند. بهتر است که موارد زیر را حتما در توضیحات خود لحاظ نمایید:

برنامه شما چه می کند.
علت استفاده فناوری های بکار گرفته شده در پروژه
برخی از چالش‌هایی که با آن روبرو بودید و ویژگی‌هایی که امیدوارید در آینده پیاده‌سازی کنید.

یک README خوب به شما کمک می کند تا در میان جمعیت زیادی از توسعه دهندگانی که کار خود را در گیت هاب قرار می دهند برجسته شوید.

طراحی سایت مارکت پلیس